CE Gobi SDK  2.14
GobiApi
QmiWDS.h
1 /*===========================================================================
2 FILE:
3  GobiNASAPI.h
4 
5 DESCRIPTION:
6  Gobi Wireless Data Service APIs
7 
8 Copyright (C) 2015 Sierra Wireless Incorporated. All rights reserved.
9  Sierra Wireless Proprietary/GTDR
10 ==========================================================================*/
11 
12 #ifndef __GOBI_WDS_API_H__
13 #define __GOBI_WDS_API_H__
14 /*=========================================================================*/
15 // Definitions
16 /*=========================================================================*/
17 
22 
23 /*=========================================================================*/
24 // Structs
25 /*=========================================================================*/
26 #ifdef __cplusplus
27  extern "C" {
28 #endif
29 
30 /*=========================================================================*/
31 // Callbacks
32 /*=========================================================================*/
33 
34 #ifdef __cplusplus
35  };
36 #endif
37 
38 /*=========================================================================*/
39 // Prototypes
40 /*=========================================================================*/
52 IMPORTGOBI ULONG GOBICMAPI SetClientIPFamilyPreference( ULONG prefIPFamily );
53 
64 IMPORTGOBI ULONG GOBICMAPI SetDormancyStatusCallback(
65  tFNDormancyStatus pCallback );
66 
67 
80 IMPORTGOBI ULONG GOBICMAPI SetByteTotalsCallback(
81  tFNByteTotals pCallback,
82  BYTE interval );
83 
99 IMPORTGOBI ULONG GOBICMAPI SetSessionStateCallback( tFNSessionState pCallback );
100 
101 
112 IMPORTGOBI ULONG GOBICMAPI SetMobileIPStatusCallback(
113  tFNMobileIPStatus pCallback );
114 
115 
127 IMPORTGOBI ULONG GOBICMAPI SetDataBearerCallback( tFNDataBearer pCallback );
128 
140 IMPORTGOBI ULONG GOBICMAPI GetDataBearerTechnology( ULONG * pDataBearer );
141 
153 IMPORTGOBI ULONG GOBICMAPI GetSessionState( ULONG * pState );
154 
165 IMPORTGOBI ULONG GOBICMAPI GetSessionDuration( ULONGLONG * pDuration );
166 
177 IMPORTGOBI ULONG GOBICMAPI GetDormancyState( ULONG * pState );
178 
190 IMPORTGOBI ULONG GOBICMAPI GetAutoconnect( ULONG * pSetting );
191 
202 
203 IMPORTGOBI ULONG GOBICMAPI SetAutoconnect( ULONG setting );
204 
216 IMPORTGOBI ULONG GOBICMAPI GetEnhancedAutoconnect(
217  ULONG * pSetting,
218  ULONG * pRoamSetting );
219 
230 IMPORTGOBI ULONG GOBICMAPI SetEnhancedAutoconnect(
231  ULONG setting,
232  ULONG * pRoamSetting );
233 
252 IMPORTGOBI ULONG GOBICMAPI SetDefaultProfile(
253  ULONG profileType,
254  ULONG * pPDPType,
255  ULONG * pIPAddress,
256  ULONG * pPrimaryDNS,
257  ULONG * pSecondaryDNS,
258  ULONG * pAuthentication,
259  CHAR * pName,
260  CHAR * pAPNName,
261  CHAR * pUsername,
262  CHAR * pPassword );
263 
292 
293 IMPORTGOBI ULONG GOBICMAPI GetDefaultProfile(
294  ULONG profileType,
295  ULONG * pPDPType,
296  ULONG * pIPAddress,
297  ULONG * pPrimaryDNS,
298  ULONG * pSecondaryDNS,
299  ULONG * pAuthentication,
300  BYTE nameSize,
301  CHAR * pName,
302  BYTE apnSize,
303  CHAR * pAPNName,
304  BYTE userSize,
305  CHAR * pUsername );
306 
321 IMPORTGOBI ULONG GOBICMAPI SetDefaultIPv6Profile(
322  ULONG profileType,
323  USHORT * pIPAddress,
324  USHORT * pPrimaryDNS,
325  USHORT * pSecondaryDNS );
326 
341 IMPORTGOBI ULONG GOBICMAPI GetDefaultIPv6Profile(
342  ULONG profileType,
343  USHORT * pIPAddress,
344  USHORT * pPrimaryDNS,
345  USHORT * pSecondaryDNS );
346 
381 IMPORTGOBI ULONG GOBICMAPI StartDataSession2(
382  ULONG * pTechnology,
383  ULONG * pPrimaryDNS,
384  ULONG * pSecondaryDNS,
385  ULONG * pPrimaryNBNS,
386  ULONG * pSecondaryNBNS,
387  CHAR * pAPNName,
388  ULONG * pIPAddress,
389  ULONG * pAuthentication,
390  CHAR * pUsername,
391  CHAR * pPassword,
392  ULONG * pSessionId,
393  ULONG * pFailureReason );
394 
417 IMPORTGOBI ULONG GOBICMAPI StartDataSession(
418  ULONG * pTechnology,
419  ULONG * pPrimaryDNS,
420  ULONG * pSecondaryDNS,
421  ULONG * pPrimaryNBNS,
422  ULONG * pSecondaryNBNS,
423  CHAR * pAPNName,
424  ULONG * pIPAddress,
425  ULONG * pAuthentication,
426  CHAR * pUsername,
427  CHAR * pPassword,
428  ULONG * pSessionId );
429 
438 IMPORTGOBI ULONG GOBICMAPI CancelDataSession();
439 
450 IMPORTGOBI ULONG GOBICMAPI StopDataSession( ULONG sessionId );
451 
462 IMPORTGOBI ULONG GOBICMAPI GetIPAddress( ULONG * pIPAddress );
463 
476 IMPORTGOBI ULONG GOBICMAPI GetConnectionRate(
477  ULONG * pCurrentChannelTXRate,
478  ULONG * pCurrentChannelRXRate,
479  ULONG * pMaxChannelTXRate,
480  ULONG * pMaxChannelRXRate );
481 
496 IMPORTGOBI ULONG GOBICMAPI GetPacketStatus(
497  ULONG * pTXPacketSuccesses,
498  ULONG * pRXPacketSuccesses,
499  ULONG * pTXPacketErrors,
500  ULONG * pRXPacketErrors,
501  ULONG * pTXPacketOverflows,
502  ULONG * pRXPacketOverflows );
503 
514 
515 IMPORTGOBI ULONG GOBICMAPI GetByteTotals(
516  ULONGLONG * pTXTotalBytes,
517  ULONGLONG * pRXTotalBytes );
518 
528 IMPORTGOBI ULONG GOBICMAPI SetMobileIP( ULONG mode );
529 
540 IMPORTGOBI ULONG GOBICMAPI GetMobileIP( ULONG * pMode );
541 
552 IMPORTGOBI ULONG GOBICMAPI SetActiveMobileIPProfile(
553  CHAR * pSPC,
554  BYTE index );
555 
565 IMPORTGOBI ULONG GOBICMAPI GetActiveMobileIPProfile( BYTE * pIndex );
566 
599 
600 IMPORTGOBI ULONG GOBICMAPI SetMobileIPProfile(
601  CHAR * pSPC,
602  BYTE index,
603  BYTE * pEnabled,
604  ULONG * pAddress,
605  ULONG * pPrimaryHA,
606  ULONG * pSecondaryHA,
607  BYTE * pRevTunneling,
608  CHAR * pNAI,
609  ULONG * pHASPI,
610  ULONG * pAAASPI,
611  CHAR * pMNHA,
612  CHAR * pMNAAA );
613 
634 IMPORTGOBI ULONG GOBICMAPI GetMobileIPProfile2(
635  BYTE index,
636  BYTE * pEnabled,
637  ULONG * pAddress,
638  ULONG * pPrimaryHA,
639  ULONG * pSecondaryHA,
640  BYTE * pRevTunneling,
641  BYTE naiSize,
642  CHAR * pNAI,
643  ULONG * pHASPI,
644  ULONG * pAAASPI,
645  ULONG * pHAState,
646  ULONG * pAAAState );
647 
676 IMPORTGOBI ULONG GOBICMAPI GetMobileIPProfile(
677  BYTE index,
678  BYTE * pEnabled,
679  ULONG * pAddress,
680  ULONG * pPrimaryHA,
681  ULONG * pSecondaryHA,
682  BYTE * pRevTunneling,
683  BYTE naiSize,
684  CHAR * pNAI,
685  ULONG * pHASPI,
686  ULONG * pAAASPI );
687 
704 IMPORTGOBI ULONG GOBICMAPI SetMobileIPParameters(
705  CHAR * pSPC,
706  ULONG * pMode,
707  BYTE * pRetryLimit,
708  BYTE * pRetryInterval,
709  BYTE * pReRegPeriod,
710  BYTE * pReRegTraffic,
711  BYTE * pHAAuthenticator,
712  BYTE * pHA2002bis );
713 
729 IMPORTGOBI ULONG GOBICMAPI GetMobileIPParameters(
730  ULONG * pMode,
731  BYTE * pRetryLimit,
732  BYTE * pRetryInterval,
733  BYTE * pReRegPeriod,
734  BYTE * pReRegTraffic,
735  BYTE * pHAAuthenticator,
736  BYTE * pHA2002bis );
737 
747 IMPORTGOBI ULONG GOBICMAPI GetLastMobileIPError( ULONG * pError );
748 
760 IMPORTGOBI ULONG GOBICMAPI SetDNSSettings(
761  ULONG * pPrimaryDNS,
762  ULONG * pSecondaryDNS );
763 
775 IMPORTGOBI ULONG GOBICMAPI GetDNSSettings(
776  ULONG * pPrimaryDNS,
777  ULONG * pSecondaryDNS );
778 
791 IMPORTGOBI ULONG GOBICMAPI SetDNSIPv6Settings(
792  USHORT * pPrimaryDNS,
793  USHORT * pSecondaryDNS );
794 
806 IMPORTGOBI ULONG GOBICMAPI GetDNSIPv6Settings(
807  USHORT * pPrimaryDNS,
808  USHORT * pSecondaryDNS );
809 
820 IMPORTGOBI ULONG GOBICMAPI SetClientIPFamilyPreference( ULONG prefIPFamily );
821 
832 QCIMPORT2K ULONG QCWWANAPI2K SetPacketTotalsCallback(
833  tFNPacketTotals pCallback,
834  BYTE interval ); // End of WDS group
836 #endif
GetMobileIP
IMPORTGOBI ULONG GOBICMAPI GetMobileIP(ULONG *pMode)
tFNPacketTotals
void(SWICALLBACK * tFNPacketTotals)(ULONG totalPacketTX, ULONG totalPacketRX)
API Return Codes.
Definition: SwiWwanCmApi.h:60
GetActiveMobileIPProfile
IMPORTGOBI ULONG GOBICMAPI GetActiveMobileIPProfile(BYTE *pIndex)
GetAutoconnect
IMPORTGOBI ULONG GOBICMAPI GetAutoconnect(ULONG *pSetting)
StartDataSession
IMPORTGOBI ULONG GOBICMAPI StartDataSession(ULONG *pTechnology, ULONG *pPrimaryDNS, ULONG *pSecondaryDNS, ULONG *pPrimaryNBNS, ULONG *pSecondaryNBNS, CHAR *pAPNName, ULONG *pIPAddress, ULONG *pAuthentication, CHAR *pUsername, CHAR *pPassword, ULONG *pSessionId)
StartDataSession2
IMPORTGOBI ULONG GOBICMAPI StartDataSession2(ULONG *pTechnology, ULONG *pPrimaryDNS, ULONG *pSecondaryDNS, ULONG *pPrimaryNBNS, ULONG *pSecondaryNBNS, CHAR *pAPNName, ULONG *pIPAddress, ULONG *pAuthentication, CHAR *pUsername, CHAR *pPassword, ULONG *pSessionId, ULONG *pFailureReason)
SetDNSIPv6Settings
IMPORTGOBI ULONG GOBICMAPI SetDNSIPv6Settings(USHORT *pPrimaryDNS, USHORT *pSecondaryDNS)
GetEnhancedAutoconnect
IMPORTGOBI ULONG GOBICMAPI GetEnhancedAutoconnect(ULONG *pSetting, ULONG *pRoamSetting)
GetSessionState
IMPORTGOBI ULONG GOBICMAPI GetSessionState(ULONG *pState)
SetMobileIP
IMPORTGOBI ULONG GOBICMAPI SetMobileIP(ULONG mode)
SetPacketTotalsCallback
QCIMPORT2K ULONG QCWWANAPI2K SetPacketTotalsCallback(tFNPacketTotals pCallback, BYTE interval)
GetDataBearerTechnology
IMPORTGOBI ULONG GOBICMAPI GetDataBearerTechnology(ULONG *pDataBearer)
CancelDataSession
IMPORTGOBI ULONG GOBICMAPI CancelDataSession()
SetDormancyStatusCallback
IMPORTGOBI ULONG GOBICMAPI SetDormancyStatusCallback(tFNDormancyStatus pCallback)
GetConnectionRate
IMPORTGOBI ULONG GOBICMAPI GetConnectionRate(ULONG *pCurrentChannelTXRate, ULONG *pCurrentChannelRXRate, ULONG *pMaxChannelTXRate, ULONG *pMaxChannelRXRate)
SetDNSSettings
IMPORTGOBI ULONG GOBICMAPI SetDNSSettings(ULONG *pPrimaryDNS, ULONG *pSecondaryDNS)
GetMobileIPProfile
IMPORTGOBI ULONG GOBICMAPI GetMobileIPProfile(BYTE index, BYTE *pEnabled, ULONG *pAddress, ULONG *pPrimaryHA, ULONG *pSecondaryHA, BYTE *pRevTunneling, BYTE naiSize, CHAR *pNAI, ULONG *pHASPI, ULONG *pAAASPI)
GetByteTotals
IMPORTGOBI ULONG GOBICMAPI GetByteTotals(ULONGLONG *pTXTotalBytes, ULONGLONG *pRXTotalBytes)
GetDormancyState
IMPORTGOBI ULONG GOBICMAPI GetDormancyState(ULONG *pState)
GetMobileIPProfile2
IMPORTGOBI ULONG GOBICMAPI GetMobileIPProfile2(BYTE index, BYTE *pEnabled, ULONG *pAddress, ULONG *pPrimaryHA, ULONG *pSecondaryHA, BYTE *pRevTunneling, BYTE naiSize, CHAR *pNAI, ULONG *pHASPI, ULONG *pAAASPI, ULONG *pHAState, ULONG *pAAAState)
SetMobileIPProfile
IMPORTGOBI ULONG GOBICMAPI SetMobileIPProfile(CHAR *pSPC, BYTE index, BYTE *pEnabled, ULONG *pAddress, ULONG *pPrimaryHA, ULONG *pSecondaryHA, BYTE *pRevTunneling, CHAR *pNAI, ULONG *pHASPI, ULONG *pAAASPI, CHAR *pMNHA, CHAR *pMNAAA)
SetAutoconnect
IMPORTGOBI ULONG GOBICMAPI SetAutoconnect(ULONG setting)
GetMobileIPParameters
IMPORTGOBI ULONG GOBICMAPI GetMobileIPParameters(ULONG *pMode, BYTE *pRetryLimit, BYTE *pRetryInterval, BYTE *pReRegPeriod, BYTE *pReRegTraffic, BYTE *pHAAuthenticator, BYTE *pHA2002bis)
SetActiveMobileIPProfile
IMPORTGOBI ULONG GOBICMAPI SetActiveMobileIPProfile(CHAR *pSPC, BYTE index)
GetDNSSettings
IMPORTGOBI ULONG GOBICMAPI GetDNSSettings(ULONG *pPrimaryDNS, ULONG *pSecondaryDNS)
GetDefaultIPv6Profile
IMPORTGOBI ULONG GOBICMAPI GetDefaultIPv6Profile(ULONG profileType, USHORT *pIPAddress, USHORT *pPrimaryDNS, USHORT *pSecondaryDNS)
SetDefaultProfile
IMPORTGOBI ULONG GOBICMAPI SetDefaultProfile(ULONG profileType, ULONG *pPDPType, ULONG *pIPAddress, ULONG *pPrimaryDNS, ULONG *pSecondaryDNS, ULONG *pAuthentication, CHAR *pName, CHAR *pAPNName, CHAR *pUsername, CHAR *pPassword)
SetDefaultIPv6Profile
IMPORTGOBI ULONG GOBICMAPI SetDefaultIPv6Profile(ULONG profileType, USHORT *pIPAddress, USHORT *pPrimaryDNS, USHORT *pSecondaryDNS)
GetIPAddress
IMPORTGOBI ULONG GOBICMAPI GetIPAddress(ULONG *pIPAddress)
SetMobileIPStatusCallback
IMPORTGOBI ULONG GOBICMAPI SetMobileIPStatusCallback(tFNMobileIPStatus pCallback)
SetMobileIPParameters
IMPORTGOBI ULONG GOBICMAPI SetMobileIPParameters(CHAR *pSPC, ULONG *pMode, BYTE *pRetryLimit, BYTE *pRetryInterval, BYTE *pReRegPeriod, BYTE *pReRegTraffic, BYTE *pHAAuthenticator, BYTE *pHA2002bis)
GetDNSIPv6Settings
IMPORTGOBI ULONG GOBICMAPI GetDNSIPv6Settings(USHORT *pPrimaryDNS, USHORT *pSecondaryDNS)
SetClientIPFamilyPreference
IMPORTGOBI ULONG GOBICMAPI SetClientIPFamilyPreference(ULONG prefIPFamily)
SetEnhancedAutoconnect
IMPORTGOBI ULONG GOBICMAPI SetEnhancedAutoconnect(ULONG setting, ULONG *pRoamSetting)
GetPacketStatus
IMPORTGOBI ULONG GOBICMAPI GetPacketStatus(ULONG *pTXPacketSuccesses, ULONG *pRXPacketSuccesses, ULONG *pTXPacketErrors, ULONG *pRXPacketErrors, ULONG *pTXPacketOverflows, ULONG *pRXPacketOverflows)
GetSessionDuration
IMPORTGOBI ULONG GOBICMAPI GetSessionDuration(ULONGLONG *pDuration)
GetLastMobileIPError
IMPORTGOBI ULONG GOBICMAPI GetLastMobileIPError(ULONG *pError)
StopDataSession
IMPORTGOBI ULONG GOBICMAPI StopDataSession(ULONG sessionId)
SetSessionStateCallback
IMPORTGOBI ULONG GOBICMAPI SetSessionStateCallback(tFNSessionState pCallback)
SetByteTotalsCallback
IMPORTGOBI ULONG GOBICMAPI SetByteTotalsCallback(tFNByteTotals pCallback, BYTE interval)
GetDefaultProfile
IMPORTGOBI ULONG GOBICMAPI GetDefaultProfile(ULONG profileType, ULONG *pPDPType, ULONG *pIPAddress, ULONG *pPrimaryDNS, ULONG *pSecondaryDNS, ULONG *pAuthentication, BYTE nameSize, CHAR *pName, BYTE apnSize, CHAR *pAPNName, BYTE userSize, CHAR *pUsername)
SetDataBearerCallback
IMPORTGOBI ULONG GOBICMAPI SetDataBearerCallback(tFNDataBearer pCallback)